Skip to content

Fix MCP client documentation inconsistencies #2357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

DouweM
Copy link
Collaborator

@DouweM DouweM commented Jul 29, 2025

Fixes #2342

This PR addresses the documentation issues reported in the MCP client documentation:

  • Fixed counting inconsistency: changed "two ways" to "three ways" to match the three transport methods listed
  • Made the Streamable HTTP example consistent by updating the example to use the add function and updating the explanation to describe the add tool call instead of run_python_code

The documentation now correctly matches the server example code with its explanation.

Generated with Claude Code

- Changed ''two ways'' to ''three ways'' to match the three transport methods listed
- Updated Streamable HTTP example to show add function instead of date calculation
- Updated explanation to describe add tool call instead of run_python_code
- Made description consistent with the actual server example code

Co-authored-by: Douwe Maan <[email protected]>
@DouweM DouweM self-assigned this Jul 29, 2025
Copy link
Contributor

hyperlint-ai bot commented Jul 29, 2025

PR Change Summary

Updated MCP client documentation to resolve inconsistencies and improve clarity.

  • Corrected the number of connection methods from two to three in the documentation.
  • Updated the Streamable HTTP example to use the add function instead of run_python_code.
  • Revised the explanation to accurately reflect the add tool call.

Modified Files

  • docs/mcp/client.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link

Docs Preview

commit: 531c2c3
Preview URL: https://45eaf074-pydantic-ai-previews.pydantic.workers.dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MCP client documentation issues
1 participant